revelplayer/com.reveldigital.player.api/[androidJvm]RevelControl

RevelControl

interface RevelControl

Defines the contract for a controllable visual component or logical unit within the RevelDigital player's display surface or operational flow.

A RevelControl represents an individual element that can be positioned, sized, and layered (via Z-index). It typically encapsulates specific content or functionality, such as displaying a Playlist, running a Module, or presenting other media.

This interface provides methods to access its spatial properties (left, top, width, height, Z-index), its identifying name, associated content (like a playlist or module type), configuration Options, and lifecycle management (initialize, start, stop, dispose).

Implementations of RevelControl are the building blocks of a player's layout and dynamic behavior.

See also

Inheritors

StaticImageView

Functions

abstract fun dispose()

Releases any resources held by this control and prepares it for removal or permanent deactivation.

abstract fun getHeight(): Int

Gets the height of this control in pixels.

abstract fun getLeft(): Int

Gets the horizontal offset (X-coordinate) of the control's top-left corner relative to its parent container, in pixels.

abstract fun getName(): String

Gets the unique name assigned to this control.

abstract fun getOptions(): Iterator<out Option>

Gets an iterator over the configuration Options for this control.

abstract fun getPlaylist(): Playlist

Gets the Playlist associated with this control, if any.

abstract fun getTop(): Int

Gets the vertical offset (Y-coordinate) of the control's top-left corner relative to its parent container, in pixels.

abstract fun getType(): ModuleType

Gets the type of the underlying module or content associated with this control.

abstract fun getWidth(): Int

Gets the width of this control in pixels.

abstract fun getZIndex(): Int

Gets the Z-index (stacking order) of this control.

abstract fun initialize(module: Module)

Initializes the control with its associated module context.

abstract fun isAutoStart(): Boolean

Checks if this control is configured to start its operation automatically after initialization.

abstract fun isStarted(): Boolean

Checks if the control is currently in a started or active operational state.

abstract fun setAutoStart(flag: Boolean)

Sets whether this control should start its operation automatically after initialization.

abstract fun setLeft(offset: Int)

Sets the horizontal offset (X-coordinate) of the control's top-left corner.

abstract fun setTop(offset: Int)

Sets the vertical offset (Y-coordinate) of the control's top-left corner.

abstract fun start()

Starts or resumes the active operation of this control.

abstract fun stop()

Stops or pauses the active operation of this control.